/*
 * Licensed to Elasticsearch under one or more contributor
 * license agreements. See the NOTICE file distributed with
 * this work for additional information regarding copyright
 * ownership. Elasticsearch licenses this file to you under
 * the Apache License, Version 2.0 (the "License"); you may
 * not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */

package org.elasticsearch.search;

import org.elasticsearch.common.io.stream.Streamable;

import java.util.List;

/**
 * A single field name and values part of a {@link SearchHit}.
 *
 * @see SearchHit
 */
public interface SearchHitField extends Streamable, Iterable<Object> {

    /**
     * The name of the field.
     */
    String name();

    /**
     * The name of the field.
     */
    String getName();

    /**
     * The first value of the hit.
     */
    <V> V value();

    /**
     * The first value of the hit.
     */
    <V> V getValue();

    /**
     * The field values.
     */
    List<Object> values();

    /**
     * The field values.
     */
    List<Object> getValues();

    /**
     * @return The field is a metadata field
     */
    boolean isMetadataField();
}
